Show:

Streams import Class

Defined in: platform/plugins/Streams/handlers/Streams/import/tool.php:7
Module: Streams-tools

Allows $app/admins in a community o download of sample csv and upload a filled-out csv. The upload starts a Streams/task where Streams/import handler runs and creates users from the csv, inviting them to certain Streams/experience streams in the community. It also listens to Streams/task/progress messages on the task, displays progress and provides a way to send mass messages to follow up the invitation messages.

Constructor

Streams import

(
  • [$options]
  • [$options.linkTitle="Fill
  • [$options.fileLabel="Upload
)

Defined in platform/plugins/Streams/handlers/Streams/import/tool.php:7

Parameters:

  • [$options] Array optional

    this array contains function parameters

    • [link] String optional

      Required. URL to the csv file to download, if any. Can be a full url or one of "university.csv" or "building.csv".

    • [submitButton="Upload"] String optional

      The content of the submit button

    • [smsText] String optional

      The text to send in SMS followups

    • [emailSubject] String optional

      The subject of the email in followups

    • [emailBody] String optional

      The body of the email, as HTML

    • [smsBatchSize=99] String optional

      The size of followup sms batches

    • [emailBatchSize=99] String optional

      The size of followup email batches

    • [communityId=Users::communityId] String optional

      For Streams/import/post

    • [taskStreamName] String optional

      For Streams/import/post

  • [$options.linkTitle="Fill String

    Out This Spreadsheet"] The content of the link to the csv, if csv is set

  • [$options.fileLabel="Upload String

    Spreadsheet"] The content of the link to the csv, if csv is set

Item Index